Resource URL: /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools

    Overview: This resource exposes OneFS network pools.

     Methods: GET, POST

********************************************************************************

Method GET: Get a list of network pools.

       URL: GET
            /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools

Query arguments:
       sort=<string> The field that will be used for sorting.
     resume=<string> Continue returning results from previous call using this
                     token (token should come from the previous call, resume
                     cannot be used with other options).
access_zone=<string> If specified, only pools with this zone name will be
                     returned.
 alloc_method=<enum> Where <enum> is one of static, dynamic.  If specified,
                     only pools with this allocation type will be returned.
     limit=<integer> Return no more than this many results at once (see resume).
          dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the
                     sort.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "pools": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "ifaces": {
                "items": {
                  "type": "object", 
                  "properties": {
                    "iface": {
                      "type": "string", 
                      "description": "A string that defines an interface name."
                    }, 
                    "lnn": {
                      "type": "integer", 
                      "description": "Logical Node Number."
                    }
                  }
                }, 
                "required": true, 
                "type": "array", 
                "description": "List of interface members in this pool."
              }, 
              "aggregation_mode": {
                "enum": [
                  "roundrobin", 
                  "failover", 
                  "lacp", 
                  "fec"
                ], 
                "type": "string", 
                "description": "OneFS supports the following NIC aggregation modes.", 
                "required": true
              }, 
              "sc_failover_policy": {
                "enum": [
                  "round_robin", 
                  "conn_count", 
                  "throughput", 
                  "cpu_usage"
                ], 
                "type": "string", 
                "description": "SmartConnect IP failover policy.", 
                "required": true
              }, 
              "sc_subnet": {
                "required": true, 
                "type": "string", 
                "description": "Name of SmartConnect service subnet for this pool."
              }, 
              "sc_suspended_nodes": {
                "items": {
                  "type": "integer"
                }, 
                "required": true, 
                "type": "array", 
                "description": "List of LNNs showing currently suspended nodes in SmartConnect."
              }, 
              "id": {
                "required": true, 
                "type": "string", 
                "description": "Unique Pool ID."
              }, 
              "subnet": {
                "required": true, 
                "type": "string", 
                "description": "The name of the subnet."
              }, 
              "rebalance_policy": {
                "enum": [
                  "auto", 
                  "manual"
                ], 
                "type": "string", 
                "description": "Rebalance policy..", 
                "required": true
              }, 
              "sc_connect_policy": {
                "enum": [
                  "round_robin", 
                  "conn_count", 
                  "throughput", 
                  "cpu_usage"
                ], 
                "type": "string", 
                "description": "SmartConnect client connection balancing policy.", 
                "required": true
              }, 
              "groupnet": {
                "required": true, 
                "type": "string", 
                "description": "Name of the groupnet this pool belongs to."
              }, 
              "description": {
                "required": true, 
                "type": "string", 
                "description": "A description of the pool.", 
                "maxLength": 128
              }, 
              "rules": {
                "items": {
                  "type": "string"
                }, 
                "required": true, 
                "type": "array", 
                "description": "Names of the rules in this pool."
              }, 
              "access_zone": {
                "minLength": 1, 
                "required": true, 
                "type": "string", 
                "description": "Name of a valid access zone to map IP address pool to the zone."
              }, 
              "alloc_method": {
                "enum": [
                  "dynamic", 
                  "static"
                ], 
                "type": "string", 
                "description": "Specifies how IP address allocation is done among pool members.", 
                "required": true
              }, 
              "ranges": {
                "items": {
                  "type": "object", 
                  "properties": {
                    "high": {
                      "required": true, 
                      "type": "string", 
                      "description": "High IP"
                    }, 
                    "low": {
                      "required": true, 
                      "type": "string", 
                      "description": "Low IP"
                    }
                  }
                }, 
                "required": true, 
                "type": "array", 
                "description": "List of IP address ranges in this pool."
              }, 
              "sc_dns_zone_aliases": {
                "items": {
                  "type": "string"
                }, 
                "required": true, 
                "type": "array", 
                "description": "List of SmartConnect zone aliases (DNS names) to the pool."
              }, 
              "sc_dns_zone": {
                "required": true, 
                "type": "string", 
                "description": "SmartConnect zone name for the pool."
              }, 
              "name": {
                "required": true, 
                "type": "string", 
                "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", 
                "maxLength": 32
              }, 
              "static_routes": {
                "items": {
                  "type": "object", 
                  "properties": {
                    "prefixlen": {
                      "required": true, 
                      "type": "integer", 
                      "description": "Prefix length in the format: nn."
                    }, 
                    "subnet": {
                      "required": true, 
                      "type": "string", 
                      "description": "Network address in the format: xxx.xxx.xxx.xxx"
                    }, 
                    "gateway": {
                      "required": true, 
                      "type": "string", 
                      "description": "Address of the gateway in the format: yyy.yyy.yyy.yyy"
                    }
                  }
                }, 
                "required": true, 
                "type": "array", 
                "description": "List of interface members in this pool."
              }, 
              "sc_ttl": {
                "required": true, 
                "minimum": 0, 
                "type": "integer", 
                "description": "Time to live value for SmartConnect DNS query responses in seconds.", 
                "maximum": 2147483647
              }, 
              "addr_family": {
                "enum": [
                  "ipv4", 
                  "ipv6"
                ], 
                "type": "string", 
                "description": "IP address format.", 
                "required": true
              }, 
              "sc_auto_unsuspend_delay": {
                "required": true, 
                "minimum": 0, 
                "type": "integer", 
                "description": "Time delay in seconds before a node which has been                 automatically unsuspended becomes usable in SmartConnect                responses for pool zones.", 
                "maximum": 86400
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}

********************************************************************************

Method POST: Create a new pool.

        URL: POST
             /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools

Query arguments:
force=<boolean> Force creating this pool even if it causes an MTU conflict.

Required POST request body fields:
name

POST request body schema:
{
  "type": "object", 
  "properties": {
    "ranges": {
      "items": {
        "type": "object", 
        "properties": {
          "high": {
            "required": true, 
            "type": "string", 
            "description": "High IP"
          }, 
          "low": {
            "required": true, 
            "type": "string", 
            "description": "Low IP"
          }
        }
      }, 
      "type": "array", 
      "description": "List of IP address ranges in this pool."
    }, 
    "sc_ttl": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Time to live value for SmartConnect DNS query responses in seconds.", 
      "maximum": 2147483647
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", 
      "maxLength": 32
    }, 
    "static_routes": {
      "items": {
        "type": "object", 
        "properties": {
          "prefixlen": {
            "required": true, 
            "type": "integer", 
            "description": "Prefix length in the format: nn."
          }, 
          "subnet": {
            "required": true, 
            "type": "string", 
            "description": "Network address in the format: xxx.xxx.xxx.xxx"
          }, 
          "gateway": {
            "required": true, 
            "type": "string", 
            "description": "Address of the gateway in the format: yyy.yyy.yyy.yyy"
          }
        }
      }, 
      "type": "array", 
      "description": "List of interface members in this pool."
    }, 
    "ifaces": {
      "items": {
        "type": "object", 
        "properties": {
          "iface": {
            "type": "string", 
            "description": "A string that defines an interface name."
          }, 
          "lnn": {
            "type": "integer", 
            "description": "Logical Node Number."
          }
        }
      }, 
      "type": "array", 
      "description": "List of interface members in this pool."
    }, 
    "sc_auto_unsuspend_delay": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Time delay in seconds before a node which has been                 automatically unsuspended becomes usable in SmartConnect                responses for pool zones.", 
      "maximum": 86400
    }, 
    "sc_subnet": {
      "type": "string", 
      "description": "Name of SmartConnect service subnet for this pool."
    }, 
    "access_zone": {
      "minLength": 1, 
      "type": "string", 
      "description": "Name of a valid access zone to map IP address pool to the zone."
    }, 
    "alloc_method": {
      "enum": [
        "dynamic", 
        "static"
      ], 
      "type": "string", 
      "description": "Specifies how IP address allocation is done among pool members."
    }, 
    "rebalance_policy": {
      "enum": [
        "auto", 
        "manual"
      ], 
      "type": "string", 
      "description": "Rebalance policy.."
    }, 
    "sc_dns_zone": {
      "type": "string", 
      "description": "SmartConnect zone name for the pool."
    }, 
    "aggregation_mode": {
      "enum": [
        "roundrobin", 
        "failover", 
        "lacp", 
        "fec"
      ], 
      "type": "string", 
      "description": "OneFS supports the following NIC aggregation modes."
    }, 
    "sc_failover_policy": {
      "enum": [
        "round_robin", 
        "conn_count", 
        "throughput", 
        "cpu_usage"
      ], 
      "type": "string", 
      "description": "SmartConnect IP failover policy."
    }, 
    "sc_connect_policy": {
      "enum": [
        "round_robin", 
        "conn_count", 
        "throughput", 
        "cpu_usage"
      ], 
      "type": "string", 
      "description": "SmartConnect client connection balancing policy."
    }, 
    "sc_dns_zone_aliases": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of SmartConnect zone aliases (DNS names) to the pool."
    }, 
    "description": {
      "type": "string", 
      "description": "A description of the pool.", 
      "maxLength": 128
    }
  }
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "id": {
          "minLength": 0, 
          "required": true, 
          "type": "string", 
          "description": "ID of created item that can be used to refer to item in the collection-item resource path.", 
          "maxLength": 255
        }
      }
    }
  ]
}
